package cgl.narada.transport.rtp;
/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or GlobalMMCS,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called GlobalMMCS,
 * nor may Indiana University or Community Grids Lab or GlobalMMCS appear
 * in their name, without prior written permission of ARTI.
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */


import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.SocketException;
import java.util.ArrayList;
import java.util.StringTokenizer;

import cgl.narada.matching.rtp.RtpEvent;
import cgl.narada.transport.TransportDebugFlags;
import cgl.narada.transport.TransportHandler;

/**
    This class is used to receive RTP packages. It works with RTCPMultiReceiverThread.
    It examines the ssrc number of each package and publish it to the appropriate topic
    according to the ssrc and topic number associations.

    if there is no topic created for an ssrc, it creates a new topic for this ssrc.

    @author Ahmet Uyar
    $Revision: 1.3 $
    $Date: 2006/05/05 17:32:18 $
*/
public class RTPMultiReceiver extends Thread implements TransportDebugFlags {

   public final static int MAX_PACKET_SIZE = 65507;
   private DatagramSocket socket; // this can be either a MulticastSocket or DatagramSocket
   private int port;

   private byte[] buffer = new byte[16000];
   private int messageTracker = 0;
   private String moduleName = "RTPMultiReceiverThread: ";
   private TransportHandler transportHandler;
   private int nodeIdentifier = 0;
   private boolean stopped = false;

   private ArrayList topicList; // this will hold StreamInfo objects
   private SessionTopicManager topicManager;
   private String linkID;

   int counter = 0;
   private H261BitSetter h261BitSetter;

   // this is the list of all rtp payload types supported by jmf
   private byte[] payloadTypes = {
       0, // ULAW audio
       3, // GSM audio
       4, // G723
       5, // DVI
       26, // JPEG video
       31, // H261 video
       34, // H.263 video

       // dynamic types which we added in cgl.globalmmcs.mediaserver.audiomixer.AudioFormatAdder
       83, // ULAW 8khz stereo
       84, // ULAW 16khz mono
       85, // ULAW 16khz stereo
       86, // ULAW 32khz mono
       87, // ULAW 32khz stereo
       88, // ULAW 48khz mono
       89, // ULAW 48khz stereo
       118, // GSM 16khz mono
       119, // GSM 32khz mono
       123, // GSM 48khz mono
       122, // Linear, 16bit, 8khz, mono
       111, // Linear, 16bit, 8khz, stereo
       112, // Linear, 16bit, 16khz, mono
       113, // Linear, 16bit, 16khz, stereo
       114, // Linear, 16bit, 32khz, mono
       115, // Linear, 16bit, 32khz, stereo
       116, // Linear, 16bit, 48khz, mono
       117  // Linear, 16bit, 48khz, stereo
   };

   public RTPMultiReceiver(String linkID, DatagramSocket socket, int baseTopic, int topicRange, TransportHandler transportHandler) {
      System.out.println(moduleName + "base topic ==> " + baseTopic);

      this.linkID = linkID;
      this.socket = socket;
      this.transportHandler = transportHandler;

      byte[] buffer = new byte[MAX_PACKET_SIZE];

      topicList = new ArrayList();
      topicManager = new SessionTopicManager(baseTopic, topicRange);

      h261BitSetter = new H261BitSetter();

   }

   /**
    * return the topic manager
    */
   public ArrayList getTopicList(){
      return topicList;
   }

   public void setNodeIdentifier(int nodeId) {

      if (nodeIdentifier == 0) {
         nodeIdentifier = nodeId;
         return;
      }

      System.out.println(moduleName + "Error: Setting node identifier again?");
   }

   public void run() {
      DatagramPacket dp = new DatagramPacket(buffer, buffer.length);

      if (RTPReceiverThread_Debug) {
         System.out.println(moduleName + "waiting for Datagram packets on port " + socket.getLocalPort() + "...");
      }

      StringTokenizer token;
      int dataInfo;
      int dataLength;
      int port;
      String address;

      try {
         while ( !stopped ) {

            socket.receive(dp);
            byte[] data = dp.getData();
            port = dp.getPort();
            dataLength = dp.getLength();

            // if the received data comes from the machine where this broker runs,
            // then discard that package. Since this data could be sent from the sender of this MulticastRTPLink
            if(dp.getAddress().equals( InetAddress.getLocalHost() )){
//              System.out.println("sent package received. Ignoring...");
              continue;
            }

//            String hostInfo = dp.getAddress().getHostName();
//            int portInfo = dp.getPort();
//          String sender = "rtp://" + hostInfo + ":" + port;

            if (RTPReceiverThread_Debug) {
               /**System.out.println(moduleName + "Received [" + new String(data, 1, dataLength-1) +
                  "] from (" + hostInfo + ":" + portInfo  + ")");*/
            }

            // if dataLength is less than 12, then this is not an rtp package
            if(dataLength < 12){
               continue;
            }

            int ssrc = getSSRC(data);
            StreamInfo info = new StreamInfo(ssrc);
            int topicNumber;
            if (topicList.contains(info)) {
               StreamInfo theInfo = (StreamInfo) topicList.get(topicList.
                   indexOf(info));
               topicNumber = theInfo.getTopic();
            }
            else {

               // if the received package is not a valid rtp package, ignore it
               if (!isPayloadSupported(data))
                  continue;
               try {
                  topicNumber = topicManager.addTopic();
                  info.setTopic(topicNumber);
                  topicList.add(info);
                  System.out.println("A new stream is received with the ssrc: " +
                                     info.getSSRC() +
                                     " and it is being published to: " +
                                     info.getTopic());
               }
               catch (Exception e) {
                  System.out.println("A new stream is received with the ssrc[" +
                                     info.getSSRC() +
                                     " but topicManager is full.");
                  continue;
               }
            }

            // if this is a H.261 package, set the freeze release bit on.
            h261BitSetter.setBit(data, 0, dataLength);

            /** The data received now has to be encapsulated into an event and
                subsequently propagated to the protocol layer via the dataReceived
                method in the transportHandler. */
            RtpEvent rtpEvent = new RtpEvent(nodeIdentifier, topicNumber, data, 0, dataLength);
            transportHandler.dataReceived(rtpEvent.getBytesWithClientFlag(), linkID);
            dp.setLength(buffer.length);

//            if(topicNumber < 110){
//              counter++;
//              if(counter % 20 == 0)
//                System.out.println("messages published so far: "+counter);
//            }
         }/* end while(true) */
      } catch (SocketException se) {
         if(se.getMessage().equals("socket closed"))
            return;
         se.printStackTrace();
      } catch (java.io.IOException ioe) {
         ioe.printStackTrace();
      }/* end try-catch*/
   }/* end (run) */

   public void close(){
      stopped = true;
      socket.close();
   }

   /**
    * return the ssrc number of this rtp package.
    */
   private int getSSRC(byte data[]){

      int ssrc = cgl.narada.util.ByteUtilities.getInt(data, 8);
      return ssrc;
   }

   /**
    * check whether this payload type is one of the supported payload types.
    * @return true if supported, false otherwise
    */
   private boolean isPayloadSupported(byte data[]){

      byte payloadType = getPayloadType(data);

      for (int i = 0; i < payloadTypes.length; i++) {
         if(payloadType == payloadTypes[i])
            return true;
      }

      return false;
   }

   /**
    * return the payload type of an rtp package
    */
   public byte getPayloadType(byte data[]) {
      // get the payload type from rtp header
      // payload type is 7 bits. They are the bits from 10th to 16th inclusive

      byte secondByte = data[1];
      // set the most significant bit of secondByte off
      byte oneHundredTwentySeven = 127; // 01111111
      secondByte = (byte) (oneHundredTwentySeven & secondByte);
      return secondByte;
   }


}


